<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2008 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: HL7Seps.html 21 2014-09-19 19:17:15Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.hl7;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.io.Serializable;<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>/**<a name="line.12"></a>
<span class="sourceLineNo">013</span> * Container for the HL7 separator and escape characters for an HL7 message.<a name="line.13"></a>
<span class="sourceLineNo">014</span> */<a name="line.14"></a>
<span class="sourceLineNo">015</span>@SuppressWarnings("serial")<a name="line.15"></a>
<span class="sourceLineNo">016</span>public final class HL7Seps implements Serializable {<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>    public static final char DEFAULT_FIELD_SEPARATOR = '|';<a name="line.18"></a>
<span class="sourceLineNo">019</span>    public static final char DEFAULT_COMPONENT_SEPARATOR = '^';<a name="line.19"></a>
<span class="sourceLineNo">020</span>    public static final char DEFAULT_REPEAT_SEPARATOR = '~';<a name="line.20"></a>
<span class="sourceLineNo">021</span>    public static final char DEFAULT_SUBCOMPONENT_SEPARATOR = '&amp;';<a name="line.21"></a>
<span class="sourceLineNo">022</span>    public static final char DEFAULT_ESCAPE_CHARACTER = '\\';<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>    public static final char FIELD_SEPARATOR_ESCAPE = 'F';<a name="line.24"></a>
<span class="sourceLineNo">025</span>    public static final char COMPONENT_SEPARATOR_ESCAPE = 'S';<a name="line.25"></a>
<span class="sourceLineNo">026</span>    public static final char REPEAT_SEPARATOR_ESCAPE = 'R';<a name="line.26"></a>
<span class="sourceLineNo">027</span>    public static final char ESCAPE_CHARACTER_ESCAPE = 'E';<a name="line.27"></a>
<span class="sourceLineNo">028</span>    public static final char SUBCOMPONENT_SEPARATOR_ESCAPE = 'T';<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>    /**<a name="line.30"></a>
<span class="sourceLineNo">031</span>     * Separator using the default HL7 separator and escape characters.<a name="line.31"></a>
<span class="sourceLineNo">032</span>     */<a name="line.32"></a>
<span class="sourceLineNo">033</span>    public static final HL7Seps DEFAULT;<a name="line.33"></a>
<span class="sourceLineNo">034</span>    static {<a name="line.34"></a>
<span class="sourceLineNo">035</span>        try {<a name="line.35"></a>
<span class="sourceLineNo">036</span>            DEFAULT = new HL7Seps(DEFAULT_FIELD_SEPARATOR, DEFAULT_COMPONENT_SEPARATOR,<a name="line.36"></a>
<span class="sourceLineNo">037</span>              DEFAULT_REPEAT_SEPARATOR, DEFAULT_ESCAPE_CHARACTER, DEFAULT_SUBCOMPONENT_SEPARATOR);<a name="line.37"></a>
<span class="sourceLineNo">038</span>        } catch (HL7ContentException e) {<a name="line.38"></a>
<span class="sourceLineNo">039</span>            throw new RuntimeException("impossible", e);<a name="line.39"></a>
<span class="sourceLineNo">040</span>        }<a name="line.40"></a>
<span class="sourceLineNo">041</span>    }<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span>    private final char fieldSep;<a name="line.43"></a>
<span class="sourceLineNo">044</span>    private final char compSep;<a name="line.44"></a>
<span class="sourceLineNo">045</span>    private final char repSep;<a name="line.45"></a>
<span class="sourceLineNo">046</span>    private final char escChar;<a name="line.46"></a>
<span class="sourceLineNo">047</span>    private final char subSep;<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>    /**<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * Constructor.<a name="line.50"></a>
<span class="sourceLineNo">051</span>     *<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * &lt;p&gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span>     * The sub-component separator and escape characters are optional and may be equal to &lt;code&gt;(char)0&lt;/code&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span>     * to indicate not defined. However, if a sub-component separator is defined, then so must be an escape<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * character.<a name="line.55"></a>
<span class="sourceLineNo">056</span>     *<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * @param fieldSep field separator<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * @param compSep component separator<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * @param repSep repetition separator<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * @param escChar escape character, or &lt;code&gt;(char)0&lt;/code&gt; for none<a name="line.60"></a>
<span class="sourceLineNo">061</span>     * @param subSep subcomponent separator, or &lt;code&gt;(char)0&lt;/code&gt; for none<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * @throws HL7ContentException if the characters are invalid according to {@link #validate}<a name="line.62"></a>
<span class="sourceLineNo">063</span>     */<a name="line.63"></a>
<span class="sourceLineNo">064</span>    public HL7Seps(char fieldSep, char compSep, char repSep, char escChar, char subSep) throws HL7ContentException {<a name="line.64"></a>
<span class="sourceLineNo">065</span>        validate(fieldSep, compSep, repSep, escChar, subSep);<a name="line.65"></a>
<span class="sourceLineNo">066</span>        this.fieldSep = fieldSep;<a name="line.66"></a>
<span class="sourceLineNo">067</span>        this.compSep = compSep;<a name="line.67"></a>
<span class="sourceLineNo">068</span>        this.repSep = repSep;<a name="line.68"></a>
<span class="sourceLineNo">069</span>        this.escChar = escChar;<a name="line.69"></a>
<span class="sourceLineNo">070</span>        this.subSep = subSep;<a name="line.70"></a>
<span class="sourceLineNo">071</span>    }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span>    /**<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * Convenience constructor for when there is no sub-component separator.<a name="line.74"></a>
<span class="sourceLineNo">075</span>     * Equivalent to:<a name="line.75"></a>
<span class="sourceLineNo">076</span>     *  &lt;blockquote&gt;<a name="line.76"></a>
<span class="sourceLineNo">077</span>     *  &lt;code&gt;HL7Seps(fieldSep, compSep, repSep, escChar, (char)0)&lt;/code&gt;<a name="line.77"></a>
<span class="sourceLineNo">078</span>     *  &lt;/blockquote&gt;<a name="line.78"></a>
<span class="sourceLineNo">079</span>     *<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @param fieldSep field separator<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * @param compSep component separator<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * @param repSep repetition separator<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * @param escChar escape character, or &lt;code&gt;(char)0&lt;/code&gt; for none<a name="line.83"></a>
<span class="sourceLineNo">084</span>     * @throws HL7ContentException if the characters are invalid according to {@link #validate}<a name="line.84"></a>
<span class="sourceLineNo">085</span>     */<a name="line.85"></a>
<span class="sourceLineNo">086</span>    public HL7Seps(char fieldSep, char compSep, char repSep, char escChar) throws HL7ContentException {<a name="line.86"></a>
<span class="sourceLineNo">087</span>        this(fieldSep, compSep, repSep, escChar, '\u0000');<a name="line.87"></a>
<span class="sourceLineNo">088</span>    }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span>    /**<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * Convenience constructor for when there is no sub-component separator and no escape character.<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * Equivalent to:<a name="line.92"></a>
<span class="sourceLineNo">093</span>     *  &lt;blockquote&gt;<a name="line.93"></a>
<span class="sourceLineNo">094</span>     *  &lt;code&gt;HL7Seps(fieldSep, compSep, repSep, (char)0, (char)0)&lt;/code&gt;<a name="line.94"></a>
<span class="sourceLineNo">095</span>     *  &lt;/blockquote&gt;<a name="line.95"></a>
<span class="sourceLineNo">096</span>     *<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * @param fieldSep field separator<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * @param compSep component separator<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * @param repSep repetition separator<a name="line.99"></a>
<span class="sourceLineNo">100</span>     * @throws HL7ContentException if the characters are invalid according to {@link #validate}<a name="line.100"></a>
<span class="sourceLineNo">101</span>     */<a name="line.101"></a>
<span class="sourceLineNo">102</span>    public HL7Seps(char fieldSep, char compSep, char repSep) throws HL7ContentException {<a name="line.102"></a>
<span class="sourceLineNo">103</span>        this(fieldSep, compSep, repSep, '\u0000', '\u0000');<a name="line.103"></a>
<span class="sourceLineNo">104</span>    }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span>    /**<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * Get the field separator character.<a name="line.107"></a>
<span class="sourceLineNo">108</span>     *<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * @return field separator character<a name="line.109"></a>
<span class="sourceLineNo">110</span>     */<a name="line.110"></a>
<span class="sourceLineNo">111</span>    public char getFieldSep() {<a name="line.111"></a>
<span class="sourceLineNo">112</span>        return this.fieldSep;<a name="line.112"></a>
<span class="sourceLineNo">113</span>    }<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span>    /**<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * Get the component separator character.<a name="line.116"></a>
<span class="sourceLineNo">117</span>     *<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * @return component separator character<a name="line.118"></a>
<span class="sourceLineNo">119</span>     */<a name="line.119"></a>
<span class="sourceLineNo">120</span>    public char getCompSep() {<a name="line.120"></a>
<span class="sourceLineNo">121</span>        return this.compSep;<a name="line.121"></a>
<span class="sourceLineNo">122</span>    }<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span>    /**<a name="line.124"></a>
<span class="sourceLineNo">125</span>     * Get the repeat separator character.<a name="line.125"></a>
<span class="sourceLineNo">126</span>     *<a name="line.126"></a>
<span class="sourceLineNo">127</span>     * @return repeat separator character<a name="line.127"></a>
<span class="sourceLineNo">128</span>     */<a name="line.128"></a>
<span class="sourceLineNo">129</span>    public char getRepSep() {<a name="line.129"></a>
<span class="sourceLineNo">130</span>        return this.repSep;<a name="line.130"></a>
<span class="sourceLineNo">131</span>    }<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span>    /**<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * Get the escape character.<a name="line.134"></a>
<span class="sourceLineNo">135</span>     *<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * @return escape character(char)0&lt;/code&gt; for none<a name="line.136"></a>
<span class="sourceLineNo">137</span>     * @see #hasEscapeCharacter<a name="line.137"></a>
<span class="sourceLineNo">138</span>     */<a name="line.138"></a>
<span class="sourceLineNo">139</span>    public char getEscChar() {<a name="line.139"></a>
<span class="sourceLineNo">140</span>        return this.escChar;<a name="line.140"></a>
<span class="sourceLineNo">141</span>    }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span>    /**<a name="line.143"></a>
<span class="sourceLineNo">144</span>     * Get the sub-component separator character.<a name="line.144"></a>
<span class="sourceLineNo">145</span>     *<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * @return sub-component separator character, or &lt;code&gt;(char)0&lt;/code&gt; for none<a name="line.146"></a>
<span class="sourceLineNo">147</span>     * @see #hasSubcomponentSeparator<a name="line.147"></a>
<span class="sourceLineNo">148</span>     */<a name="line.148"></a>
<span class="sourceLineNo">149</span>    public char getSubSep() {<a name="line.149"></a>
<span class="sourceLineNo">150</span>        return this.subSep;<a name="line.150"></a>
<span class="sourceLineNo">151</span>    }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span>    /**<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * Escape instances of any separator or escape character within the given string.<a name="line.154"></a>
<span class="sourceLineNo">155</span>     *<a name="line.155"></a>
<span class="sourceLineNo">156</span>     * &lt;p&gt;<a name="line.156"></a>
<span class="sourceLineNo">157</span>     * If some character needs to be escaped but there is no escape character defined, the character is silently elided.<a name="line.157"></a>
<span class="sourceLineNo">158</span>     *<a name="line.158"></a>
<span class="sourceLineNo">159</span>     * @param value the String to escape<a name="line.159"></a>
<span class="sourceLineNo">160</span>     * @return the escaped string<a name="line.160"></a>
<span class="sourceLineNo">161</span>     */<a name="line.161"></a>
<span class="sourceLineNo">162</span>    public String escape(String value) {<a name="line.162"></a>
<span class="sourceLineNo">163</span>        StringBuilder buf = new StringBuilder(value.length());<a name="line.163"></a>
<span class="sourceLineNo">164</span>        this.escape(value, buf);<a name="line.164"></a>
<span class="sourceLineNo">165</span>        return buf.toString();<a name="line.165"></a>
<span class="sourceLineNo">166</span>    }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span>    /**<a name="line.168"></a>
<span class="sourceLineNo">169</span>     * Escape instances of any separator or escape character within the given string, and add the result to the given buffer.<a name="line.169"></a>
<span class="sourceLineNo">170</span>     *<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * &lt;p&gt;<a name="line.171"></a>
<span class="sourceLineNo">172</span>     * If some character needs to be escaped but there is no escape character defined, the character is silently elided.<a name="line.172"></a>
<span class="sourceLineNo">173</span>     *<a name="line.173"></a>
<span class="sourceLineNo">174</span>     * @param value the String to escape<a name="line.174"></a>
<span class="sourceLineNo">175</span>     * @param buf buffer to append to<a name="line.175"></a>
<span class="sourceLineNo">176</span>     */<a name="line.176"></a>
<span class="sourceLineNo">177</span>    public void escape(String value, StringBuilder buf) {<a name="line.177"></a>
<span class="sourceLineNo">178</span>        final int length = value.length();<a name="line.178"></a>
<span class="sourceLineNo">179</span>        for (int i = 0; i &lt; length; i++) {<a name="line.179"></a>
<span class="sourceLineNo">180</span>            char ch = value.charAt(i);<a name="line.180"></a>
<span class="sourceLineNo">181</span>            char escapeCode;<a name="line.181"></a>
<span class="sourceLineNo">182</span>            if (ch == this.fieldSep)<a name="line.182"></a>
<span class="sourceLineNo">183</span>                escapeCode = FIELD_SEPARATOR_ESCAPE;<a name="line.183"></a>
<span class="sourceLineNo">184</span>            else if (ch == this.repSep)<a name="line.184"></a>
<span class="sourceLineNo">185</span>                escapeCode = REPEAT_SEPARATOR_ESCAPE;<a name="line.185"></a>
<span class="sourceLineNo">186</span>            else if (ch == this.compSep)<a name="line.186"></a>
<span class="sourceLineNo">187</span>                escapeCode = COMPONENT_SEPARATOR_ESCAPE;<a name="line.187"></a>
<span class="sourceLineNo">188</span>            else if (ch == this.subSep &amp;&amp; this.subSep != '\u0000')<a name="line.188"></a>
<span class="sourceLineNo">189</span>                escapeCode = SUBCOMPONENT_SEPARATOR_ESCAPE;<a name="line.189"></a>
<span class="sourceLineNo">190</span>            else if (ch == this.escChar &amp;&amp; this.escChar != '\u0000')<a name="line.190"></a>
<span class="sourceLineNo">191</span>                escapeCode = ESCAPE_CHARACTER_ESCAPE;<a name="line.191"></a>
<span class="sourceLineNo">192</span>            else {<a name="line.192"></a>
<span class="sourceLineNo">193</span>                buf.append(ch);<a name="line.193"></a>
<span class="sourceLineNo">194</span>                continue;<a name="line.194"></a>
<span class="sourceLineNo">195</span>            }<a name="line.195"></a>
<span class="sourceLineNo">196</span>            if (this.escChar != '\u0000') {<a name="line.196"></a>
<span class="sourceLineNo">197</span>                buf.append(this.escChar);<a name="line.197"></a>
<span class="sourceLineNo">198</span>                buf.append(escapeCode);<a name="line.198"></a>
<span class="sourceLineNo">199</span>                buf.append(this.escChar);<a name="line.199"></a>
<span class="sourceLineNo">200</span>            }<a name="line.200"></a>
<span class="sourceLineNo">201</span>        }<a name="line.201"></a>
<span class="sourceLineNo">202</span>    }<a name="line.202"></a>
<span class="sourceLineNo">203</span><a name="line.203"></a>
<span class="sourceLineNo">204</span>    /**<a name="line.204"></a>
<span class="sourceLineNo">205</span>     * Determine if there is a sub-component character defined.<a name="line.205"></a>
<span class="sourceLineNo">206</span>     */<a name="line.206"></a>
<span class="sourceLineNo">207</span>    public boolean hasSubcomponentSeparator() {<a name="line.207"></a>
<span class="sourceLineNo">208</span>        return this.subSep != '\u0000';<a name="line.208"></a>
<span class="sourceLineNo">209</span>    }<a name="line.209"></a>
<span class="sourceLineNo">210</span><a name="line.210"></a>
<span class="sourceLineNo">211</span>    /**<a name="line.211"></a>
<span class="sourceLineNo">212</span>     * Determine if there is an escape character defined.<a name="line.212"></a>
<span class="sourceLineNo">213</span>     */<a name="line.213"></a>
<span class="sourceLineNo">214</span>    public boolean hasEscapeCharacter() {<a name="line.214"></a>
<span class="sourceLineNo">215</span>        return this.escChar != '\u0000';<a name="line.215"></a>
<span class="sourceLineNo">216</span>    }<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span>    /**<a name="line.218"></a>
<span class="sourceLineNo">219</span>     * Parse the escaped string back into its unescaped form.<a name="line.219"></a>
<span class="sourceLineNo">220</span>     *<a name="line.220"></a>
<span class="sourceLineNo">221</span>     * &lt;p&gt;<a name="line.221"></a>
<span class="sourceLineNo">222</span>     * The string must have been previously escaped using the same escape character as is defined for this instance.<a name="line.222"></a>
<span class="sourceLineNo">223</span>     *<a name="line.223"></a>
<span class="sourceLineNo">224</span>     * &lt;p&gt;<a name="line.224"></a>
<span class="sourceLineNo">225</span>     * If no escape character is defined for this instance, the unaltered value is returned.<a name="line.225"></a>
<span class="sourceLineNo">226</span>     *<a name="line.226"></a>
<span class="sourceLineNo">227</span>     * &lt;p&gt;<a name="line.227"></a>
<span class="sourceLineNo">228</span>     * Any "custom" or invalid escapes are silently removed.<a name="line.228"></a>
<span class="sourceLineNo">229</span>     *<a name="line.229"></a>
<span class="sourceLineNo">230</span>     * &lt;p&gt;<a name="line.230"></a>
<span class="sourceLineNo">231</span>     * An unclosed escape is returned unaltered.<a name="line.231"></a>
<span class="sourceLineNo">232</span>     *<a name="line.232"></a>
<span class="sourceLineNo">233</span>     * @param value escaped string value<a name="line.233"></a>
<span class="sourceLineNo">234</span>     * @return original unescaped value<a name="line.234"></a>
<span class="sourceLineNo">235</span>     */<a name="line.235"></a>
<span class="sourceLineNo">236</span>    public String unescape(String value) {<a name="line.236"></a>
<span class="sourceLineNo">237</span><a name="line.237"></a>
<span class="sourceLineNo">238</span>        // Optimize for the common case<a name="line.238"></a>
<span class="sourceLineNo">239</span>        if (this.escChar == '\u0000' || value.indexOf(this.escChar) == -1)<a name="line.239"></a>
<span class="sourceLineNo">240</span>            return value;<a name="line.240"></a>
<span class="sourceLineNo">241</span><a name="line.241"></a>
<span class="sourceLineNo">242</span>        // Parse out escapes<a name="line.242"></a>
<span class="sourceLineNo">243</span>        StringBuilder buf = new StringBuilder(value.length());<a name="line.243"></a>
<span class="sourceLineNo">244</span>        int[] escapes = HL7Util.find(value, this.escChar);<a name="line.244"></a>
<span class="sourceLineNo">245</span>        int posn = 0;<a name="line.245"></a>
<span class="sourceLineNo">246</span>        for (int i = 0; i &lt; escapes.length; i++) {<a name="line.246"></a>
<span class="sourceLineNo">247</span><a name="line.247"></a>
<span class="sourceLineNo">248</span>            // Append substring prior to escape<a name="line.248"></a>
<span class="sourceLineNo">249</span>            buf.append(value.substring(posn, escapes[i]));<a name="line.249"></a>
<span class="sourceLineNo">250</span><a name="line.250"></a>
<span class="sourceLineNo">251</span>            // No more escapes? We're done<a name="line.251"></a>
<span class="sourceLineNo">252</span>            if (++i == escapes.length)<a name="line.252"></a>
<span class="sourceLineNo">253</span>                break;<a name="line.253"></a>
<span class="sourceLineNo">254</span><a name="line.254"></a>
<span class="sourceLineNo">255</span>            // Check for unclosed escape (ignore it)<a name="line.255"></a>
<span class="sourceLineNo">256</span>            if (i == escapes.length - 1) {<a name="line.256"></a>
<span class="sourceLineNo">257</span>                buf.append(value.substring(escapes[i - 1]));<a name="line.257"></a>
<span class="sourceLineNo">258</span>                break;<a name="line.258"></a>
<span class="sourceLineNo">259</span>            }<a name="line.259"></a>
<span class="sourceLineNo">260</span><a name="line.260"></a>
<span class="sourceLineNo">261</span>            // Check for a known escape match<a name="line.261"></a>
<span class="sourceLineNo">262</span>            if (escapes[i] == escapes[i - 1] + 2) {<a name="line.262"></a>
<span class="sourceLineNo">263</span>                switch (value.charAt(escapes[i] - 1)) {<a name="line.263"></a>
<span class="sourceLineNo">264</span>                case FIELD_SEPARATOR_ESCAPE:<a name="line.264"></a>
<span class="sourceLineNo">265</span>                    buf.append(this.fieldSep);<a name="line.265"></a>
<span class="sourceLineNo">266</span>                    break;<a name="line.266"></a>
<span class="sourceLineNo">267</span>                case COMPONENT_SEPARATOR_ESCAPE:<a name="line.267"></a>
<span class="sourceLineNo">268</span>                    buf.append(this.compSep);<a name="line.268"></a>
<span class="sourceLineNo">269</span>                    break;<a name="line.269"></a>
<span class="sourceLineNo">270</span>                case REPEAT_SEPARATOR_ESCAPE:<a name="line.270"></a>
<span class="sourceLineNo">271</span>                    buf.append(this.repSep);<a name="line.271"></a>
<span class="sourceLineNo">272</span>                    break;<a name="line.272"></a>
<span class="sourceLineNo">273</span>                case ESCAPE_CHARACTER_ESCAPE:<a name="line.273"></a>
<span class="sourceLineNo">274</span>                    buf.append(this.escChar);   // we know escChar != '\u0000'<a name="line.274"></a>
<span class="sourceLineNo">275</span>                    break;<a name="line.275"></a>
<span class="sourceLineNo">276</span>                case SUBCOMPONENT_SEPARATOR_ESCAPE:<a name="line.276"></a>
<span class="sourceLineNo">277</span>                    if (this.subSep != '\u0000') {<a name="line.277"></a>
<span class="sourceLineNo">278</span>                        buf.append(this.subSep);<a name="line.278"></a>
<span class="sourceLineNo">279</span>                        break;<a name="line.279"></a>
<span class="sourceLineNo">280</span>                    }<a name="line.280"></a>
<span class="sourceLineNo">281</span>                    // Elide unknown escape<a name="line.281"></a>
<span class="sourceLineNo">282</span>                    break;<a name="line.282"></a>
<span class="sourceLineNo">283</span>                default:<a name="line.283"></a>
<span class="sourceLineNo">284</span>                    // Elide unknown escape<a name="line.284"></a>
<span class="sourceLineNo">285</span>                    break;<a name="line.285"></a>
<span class="sourceLineNo">286</span>                }<a name="line.286"></a>
<span class="sourceLineNo">287</span>            }<a name="line.287"></a>
<span class="sourceLineNo">288</span><a name="line.288"></a>
<span class="sourceLineNo">289</span>            // Update next starting position<a name="line.289"></a>
<span class="sourceLineNo">290</span>            posn = escapes[i] + 1;<a name="line.290"></a>
<span class="sourceLineNo">291</span>        }<a name="line.291"></a>
<span class="sourceLineNo">292</span><a name="line.292"></a>
<span class="sourceLineNo">293</span>        // Done<a name="line.293"></a>
<span class="sourceLineNo">294</span>        return buf.toString();<a name="line.294"></a>
<span class="sourceLineNo">295</span>    }<a name="line.295"></a>
<span class="sourceLineNo">296</span><a name="line.296"></a>
<span class="sourceLineNo">297</span>    /**<a name="line.297"></a>
<span class="sourceLineNo">298</span>     * Returns string representation as well-formed MSH.1 and MSH.2 fields.<a name="line.298"></a>
<span class="sourceLineNo">299</span>     */<a name="line.299"></a>
<span class="sourceLineNo">300</span>    @Override<a name="line.300"></a>
<span class="sourceLineNo">301</span>    public String toString() {<a name="line.301"></a>
<span class="sourceLineNo">302</span>        StringBuilder buf = new StringBuilder(5);<a name="line.302"></a>
<span class="sourceLineNo">303</span>        buf.append(this.fieldSep);<a name="line.303"></a>
<span class="sourceLineNo">304</span>        buf.append(this.compSep);<a name="line.304"></a>
<span class="sourceLineNo">305</span>        buf.append(this.repSep);<a name="line.305"></a>
<span class="sourceLineNo">306</span>        if (this.escChar != '\u0000') {<a name="line.306"></a>
<span class="sourceLineNo">307</span>            buf.append(this.escChar);<a name="line.307"></a>
<span class="sourceLineNo">308</span>            if (this.subSep != '\u0000')<a name="line.308"></a>
<span class="sourceLineNo">309</span>                buf.append(this.subSep);<a name="line.309"></a>
<span class="sourceLineNo">310</span>        }<a name="line.310"></a>
<span class="sourceLineNo">311</span>        return buf.toString();<a name="line.311"></a>
<span class="sourceLineNo">312</span>    }<a name="line.312"></a>
<span class="sourceLineNo">313</span><a name="line.313"></a>
<span class="sourceLineNo">314</span>    @Override<a name="line.314"></a>
<span class="sourceLineNo">315</span>    public boolean equals(Object obj) {<a name="line.315"></a>
<span class="sourceLineNo">316</span>        if (obj == null || obj.getClass() != getClass())<a name="line.316"></a>
<span class="sourceLineNo">317</span>            return false;<a name="line.317"></a>
<span class="sourceLineNo">318</span>        HL7Seps that = (HL7Seps)obj;<a name="line.318"></a>
<span class="sourceLineNo">319</span>        return this.fieldSep == fieldSep<a name="line.319"></a>
<span class="sourceLineNo">320</span>          &amp;&amp; this.compSep == compSep<a name="line.320"></a>
<span class="sourceLineNo">321</span>          &amp;&amp; this.repSep == repSep<a name="line.321"></a>
<span class="sourceLineNo">322</span>          &amp;&amp; this.escChar == escChar<a name="line.322"></a>
<span class="sourceLineNo">323</span>          &amp;&amp; this.subSep == subSep;<a name="line.323"></a>
<span class="sourceLineNo">324</span>    }<a name="line.324"></a>
<span class="sourceLineNo">325</span><a name="line.325"></a>
<span class="sourceLineNo">326</span>    @Override<a name="line.326"></a>
<span class="sourceLineNo">327</span>    public int hashCode() {<a name="line.327"></a>
<span class="sourceLineNo">328</span>        return this.fieldSep &lt;&lt; 6<a name="line.328"></a>
<span class="sourceLineNo">329</span>          ^ this.compSep &lt;&lt; 6<a name="line.329"></a>
<span class="sourceLineNo">330</span>          ^ this.repSep &lt;&lt; 6<a name="line.330"></a>
<span class="sourceLineNo">331</span>          ^ this.escChar &lt;&lt; 6<a name="line.331"></a>
<span class="sourceLineNo">332</span>          ^ this.subSep &lt;&lt; 6;<a name="line.332"></a>
<span class="sourceLineNo">333</span>    }<a name="line.333"></a>
<span class="sourceLineNo">334</span><a name="line.334"></a>
<span class="sourceLineNo">335</span>    /**<a name="line.335"></a>
<span class="sourceLineNo">336</span>     * Verify that the given combination of separator and escape characters is valid.<a name="line.336"></a>
<span class="sourceLineNo">337</span>     *<a name="line.337"></a>
<span class="sourceLineNo">338</span>     * &lt;p&gt;<a name="line.338"></a>
<span class="sourceLineNo">339</span>     * This method performs the following checks:<a name="line.339"></a>
<span class="sourceLineNo">340</span>     * &lt;ul&gt;<a name="line.340"></a>
<span class="sourceLineNo">341</span>     *  &lt;li&gt;All defined characters are plain ASCII.&lt;/li&gt;<a name="line.341"></a>
<span class="sourceLineNo">342</span>     *  &lt;li&gt;All defined characters are unique.&lt;/li&gt;<a name="line.342"></a>
<span class="sourceLineNo">343</span>     *  &lt;li&gt;If a sub-component separator is defined, then so is an escape character.&lt;/li&gt;<a name="line.343"></a>
<span class="sourceLineNo">344</span>     * &lt;/ul&gt;<a name="line.344"></a>
<span class="sourceLineNo">345</span>     *<a name="line.345"></a>
<span class="sourceLineNo">346</span>     * @param fieldSep field separator<a name="line.346"></a>
<span class="sourceLineNo">347</span>     * @param compSep component separator<a name="line.347"></a>
<span class="sourceLineNo">348</span>     * @param repSep repetition separator<a name="line.348"></a>
<span class="sourceLineNo">349</span>     * @param escChar escape character, or &lt;code&gt;(char)0&lt;/code&gt; for none<a name="line.349"></a>
<span class="sourceLineNo">350</span>     * @param subSep subcomponent separator, or &lt;code&gt;(char)0&lt;/code&gt; for none<a name="line.350"></a>
<span class="sourceLineNo">351</span>     * @throws HL7ContentException if the characters are invalid<a name="line.351"></a>
<span class="sourceLineNo">352</span>     */<a name="line.352"></a>
<span class="sourceLineNo">353</span>    public static void validate(char fieldSep, char compSep, char repSep, char escChar, char subSep) throws HL7ContentException {<a name="line.353"></a>
<span class="sourceLineNo">354</span><a name="line.354"></a>
<span class="sourceLineNo">355</span>        // Line them up<a name="line.355"></a>
<span class="sourceLineNo">356</span>        char[] chars = new char[] { fieldSep, compSep, repSep, escChar, subSep };<a name="line.356"></a>
<span class="sourceLineNo">357</span>        String[] names = new String[] {<a name="line.357"></a>
<span class="sourceLineNo">358</span>          "field separator",<a name="line.358"></a>
<span class="sourceLineNo">359</span>          "component separator",<a name="line.359"></a>
<span class="sourceLineNo">360</span>          "repeat separator",<a name="line.360"></a>
<span class="sourceLineNo">361</span>          "escape character",<a name="line.361"></a>
<span class="sourceLineNo">362</span>          "sub-component separator"<a name="line.362"></a>
<span class="sourceLineNo">363</span>        };<a name="line.363"></a>
<span class="sourceLineNo">364</span><a name="line.364"></a>
<span class="sourceLineNo">365</span>        // Check for character validity<a name="line.365"></a>
<span class="sourceLineNo">366</span>        for (int i = 0; i &lt; chars.length; i++) {<a name="line.366"></a>
<span class="sourceLineNo">367</span>            if (i &gt;= 3 &amp;&amp; chars[i] == '\u0000')<a name="line.367"></a>
<span class="sourceLineNo">368</span>                continue;<a name="line.368"></a>
<span class="sourceLineNo">369</span>            if (chars[i] &lt;= ' ' || chars[i] &gt; '~')<a name="line.369"></a>
<span class="sourceLineNo">370</span>                throw new HL7ContentException("illegal " + names[i] + " `" + chars[i] + "'");<a name="line.370"></a>
<span class="sourceLineNo">371</span>        }<a name="line.371"></a>
<span class="sourceLineNo">372</span><a name="line.372"></a>
<span class="sourceLineNo">373</span>        // Sub-component defined implies escape defined<a name="line.373"></a>
<span class="sourceLineNo">374</span>        if (escChar == '\u0000' &amp;&amp; subSep != '\u0000')<a name="line.374"></a>
<span class="sourceLineNo">375</span>            throw new HL7ContentException("escape character must be defined when sub-component separator is defined");<a name="line.375"></a>
<span class="sourceLineNo">376</span><a name="line.376"></a>
<span class="sourceLineNo">377</span>        // Check for duplicates<a name="line.377"></a>
<span class="sourceLineNo">378</span>        for (int i = 0; i &lt; chars.length - 1; i++) {<a name="line.378"></a>
<span class="sourceLineNo">379</span>            if (i &gt;= 3 &amp;&amp; chars[i] == '\u0000')<a name="line.379"></a>
<span class="sourceLineNo">380</span>                continue;<a name="line.380"></a>
<span class="sourceLineNo">381</span>            for (int j = i + 1; j &lt; chars.length; j++) {<a name="line.381"></a>
<span class="sourceLineNo">382</span>                if (chars[i] == chars[j])<a name="line.382"></a>
<span class="sourceLineNo">383</span>                    throw new HL7ContentException("duplicate " + names[i] + " and " + names[j] + " `" + chars[i] + "'");<a name="line.383"></a>
<span class="sourceLineNo">384</span>            }<a name="line.384"></a>
<span class="sourceLineNo">385</span>        }<a name="line.385"></a>
<span class="sourceLineNo">386</span>    }<a name="line.386"></a>
<span class="sourceLineNo">387</span>}<a name="line.387"></a>
<span class="sourceLineNo">388</span><a name="line.388"></a>




























































</pre>
</div>
</body>
</html>
